/** 
 * @file llurllineeditorctrl.h
 * @brief Combobox-like location input control
 *
 * $LicenseInfo:firstyear=2009&license=viewergpl$
 * 
 * Copyright (c) 2009-2010, Linden Research, Inc.
 * 
 * Second Life Viewer Source Code
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
 * 
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at
 * http://secondlifegrid.net/programs/open_source/licensing/flossexception
 * 
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 * 
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 * $/LicenseInfo$
 */

#ifndef LLURLLINEEDITOR_H_
#define LLURLLINEEDITOR_H_

#include "linden_common.h"

#include "lllineeditor.h"
#include "lluictrl.h"

// LLURLLineEditor class performing escaping of an URL while copying or cutting the target text
class LLURLLineEditor: public LLLineEditor {
	LOG_CLASS( LLURLLineEditor);

public:
	// LLLineEditor overrides to do necessary escaping
	/*virtual*/		void copy();
	/*virtual*/ 	void cut();

protected:
	LLURLLineEditor(const Params&);
	friend class LLUICtrlFactory;
	friend class LLFloaterEditUI;

private:
	// util function to escape selected text and copy it to clipboard
	void 			copyEscapedURLToClipboard();
	// send a beep signal if keystroke is bad. As it is private at LLLineEditor we need own function
	void			reportBadKeystroke();

	// Helper class to do rollback if needed
	class LLURLLineEditorRollback
	{
	public:
		LLURLLineEditorRollback( LLURLLineEditor* ed )
			:
			mCursorPos( ed->mCursorPos ),
			mScrollHPos( ed->mScrollHPos ),
			mIsSelecting( ed->mIsSelecting ),
			mSelectionStart( ed->mSelectionStart ),
			mSelectionEnd( ed->mSelectionEnd )
		{
			mText = ed->getText();
		}

		void doRollback( LLURLLineEditor* ed )
		{
			ed->mCursorPos = mCursorPos;
			ed->mScrollHPos = mScrollHPos;
			ed->mIsSelecting = mIsSelecting;
			ed->mSelectionStart = mSelectionStart;
			ed->mSelectionEnd = mSelectionEnd;
			ed->mText = mText;
			ed->mPrevText = mText;
		}

		std::string getText()   { return mText; }

	private:
		std::string mText;
		S32		mCursorPos;
		S32		mScrollHPos;
		BOOL	mIsSelecting;
		S32		mSelectionStart;
		S32		mSelectionEnd;
	}; // end class LLURLLineEditorRollback

};

#endif /* LLURLLINEEDITOR_H_ */
